CUBE CONNECT Edition Help

Editing Keys (Key Definition Editor)

When in Scenario Editor all of the keys are listed, so that each can be given a value, for that specific scenario. How the key appears on Scenario Editor, and the values that it is allowed to take, is governed by the definition of the key. Keys are defined whenever they are first created, this is done through the Key Definition Editor.



To set up a key you need the following:

Name: The name must start with a letter or an underscore. Other characters allowed in the rest of the name are a digit or a space, minus or hash. The name must not be one of the system keys (CATALOG_DIR, SCENARIO_DIR, SCENARIO_CODE, SCENARIO_SHORTNAME, SCENARIO_FULLNAME)

Title: This is the text that will appear next to the key’s control (for example, Edit Box) when the full set of keys for a scenario is displayed in Scenario Editor. If it is left blank, the prompt will be the key name.

Description: Optionally, you can enter a Description for the key.

Color labels: You can select which color label this key belongs tp, which you can then be used to filter in Project Explorer for managing the keys. (Color labeling is also possible through Key Manager's context menu)

Value Type: Value types are generally self-explanatory, apart from Note. A Note is one or more lines of descriptive text that will appear on the scenario edit dialog. It can be used to give help information on how to complete the dialog. If you select a File Name type, then the key will define the full path to a file.

Control types:

o Edit box: Allows the user to enter the value to be assigned to the key

o Spin control: For integers that fall withing a specific range. Edit box with arrows to increase/decrease the value.

o Check box: For when the key takes a Boolean value type.

o Combo List/Radio Buttons: For when the key must take only one value from those defined.

o Combo Edit: Allows key to take one of the listed values or enter a different value.

Default value: Optionally, you can give a Default value that will be applied if a scenario does not define a value for the key.

Range: For Integer or Real keys, you can specify a Range, within which, the value of a key for a scenario must fall. If you select a Spin control, you must specify a range. For an Edit Box, the range is optional.

Output Value: The Output Value field is available for all key types except Note. Normally it should be left as the default which is 'unmodified text'. This means that when an application is run, and the value is substituted into the application, it is substituted exactly as entered on the Scenario Edit dialog.

For information on how to set up a key go to Working with Scenario Keys